Skip to main content

DescribeGroupedVul

Description

call the DescribeGroupedVul interface to group query vulnerability information.

Request Method

POST

Request Path

/apsara/route/aegis/DescribeGroupedVul

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
TypeBODYstringNocvevulnerability type. Includes the following categories: cve:Linux vulnerability sys:Windows vulnerability cms:WebCMS vulnerability app: application vulnerability emg: emergency vulnerability
PageSizeBODYintegerNo20The maximum number of pieces of data per page displayed during a paged query. The default value is 20.
CurrentPageBODYintegerNo1the page number of the current page displayed when querying. The starting value is 1 and the default value is 1.
regionIdBODYstringYesNo sample value for this parameter.region id
AliasNameBODYstringNoRHSA-2019:0230-Important: polkit security updatevulnerability alias.
NecessityBODYstringNoasap,later,nntfvulnerability repair necessity level. Multiple levels are separated by English commas. Valid values: asap: high later: medium nntf: low
LangBODYstringNozhthe language type of the request and receive message. zh: Chinese en: English
UuidsBODYstringNod42f938c-d962-48a0-90f9-05e4ea******asset instance unique ID list, multiple separated by English commas.
DealedBODYstringNonwhether the vulnerability is handled. y: processed n: Unprocessed
versionBODYstringNo2016-01-01version of api
GroupIdBODYstringNoweds****asset group ID.

Return data

NameTypeSample valueDescription
RequestIdstring0DFCADBA-7065-42DA-AF17-6868B9C2A8CFrequest ID of the result.
PageSizeinteger20The maximum number of pieces of data per page displayed during a paged query.
GmtLastlong1554185744000the vulnerability was last discovered in milliseconds.
LaterCountinteger0repair necessity level medium number of vulnerabilities.
AsapCountinteger0repair necessity level high number of vulnerabilities.
Namestring*** glibc security and BUG fix updatevulnerability name.
TotalCountinteger2the total number of query results.
Typestringcvevulnerability type. Includes the following categories: cve:Linux vulnerability sys:Windows vulnerability cms:WebCMS vulnerability app: application vulnerability emg: emergency vulnerability
CurrentPageinteger1the page number of the current page displayed when paging query.
HandledCountinteger0number of processed vulnerabilities.
GroupedVulItemsarrayNo sample value for this parameter.group vulnerability information.
AliasNamestringRHSA-2019:0230-Important: polkit security updatevulnerability alias.
NntfCountinteger59repair necessity level low number of vulnerabilities.
Tagsstringneed to restartvulnerability tag.

Example

Successful Response example

{
"RequestId":"0DFCADBA-7065-42DA-AF17-6868B9C2A8CF",
"PageSize":"20",
"GmtLast":"1554185744000",
"LaterCount":"0",
"AsapCount":"0",
"Name":"*** glibc security and BUG fix update",
"TotalCount":"2",
"Type":"cve",
"CurrentPage":"1",
"HandledCount":"0",
"GroupedVulItems":"",
"AliasName":"RHSA-2019:0230-Important: polkit security update",
"NntfCount":"59",
"Tags":"need to restart"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}

title: DescribeInstanceStatistics

DescribeInstanceStatistics

Description

call the DescribeInstanceStatistics interface to query the risk statistics of the asset.

Request Method

POST

Request Path

/apsara/route/aegis/DescribeInstanceStatistics

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
UuidBODYstringYesa51cec37-ed73-4c53-b467-***unique ID list of asset instances. Separate multiple IDs with English commas. description to query the risk statistics of the asset, you need to provide the unique identification ID of the asset instance, which can be obtained by using the DescribeCloudCenterInstances interface.
SourceIpBODYstringNo1.2.3.4access source IP address.
regionIdBODYstringYesNo sample value for this parameter.region id
LangBODYstringNozhthe language type of the request and receive message. zh: Chinese en: English
FromBODYstringYessasdata request source. Fixed as sas.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
Accountinteger1the grouping type of the asset. Valid values include: 0: default grouping 1: other groups
RequestIdstring7E0618A9-D5EF-4220-9471-C42B5E92719Frequest ID of the result.
Healthinteger1number of baseline check problems.
EmgNuminteger0number of emergency vulnerabilities.
DataarrayNo sample value for this parameter.statistics of asset risk.
Vulinteger4sum of all vulnerabilities: CveNum + EmgNum + SysNum + CmsNum + AppNum.
AppNuminteger0number of applied vulnerabilities.
Uuidstringus1233******unique identification ID of the asset instance.
Suspiciousinteger2number of security alerts.
CveNuminteger1number of Linux software vulnerabilities.
Trojaninteger1number of trojans.
CmsNuminteger2number of Web-CMS vulnerabilities.
SysNuminteger1Windows the number of system vulnerabilities.

Example

Successful Response example

{
"Account":"1",
"RequestId":"7E0618A9-D5EF-4220-9471-C42B5E92719F",
"Health":"1",
"EmgNum":"0",
"Data":"",
"Vul":"4",
"AppNum":"0",
"Uuid":"us1233******",
"Suspicious":"2",
"CveNum":"1",
"Trojan":"1",
"CmsNum":"2",
"SysNum":"1"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}